*********** JDBC Driver *********** .. _jdbc-overview: JDBC Overview ============= CUBRID JDBC driver (**cubrid_jdbc.jar**) implements an interface to enable access from applications in Java to CUBRID database server. CUBRID JDBC driver is installed in the < *directory where CUBRID is installed*>/**jdbc** directory. The driver has been developed based on the JDBC 2.0 specification and the default driver provided is complied with JDK 1.6. To download JDBC driver or get the latest information, please visit http://www.cubrid.org/wiki_apis/entry/cubrid-jdbc-driver\ . **Verifying CUBRID JDBC Driver Version** You can verify the version of JDBC driver as follows: :: % jar -tf cubrid_jdbc.jar META-INF/ META-INF/MANIFEST.MF cubrid/ cubrid/jdbc/ cubrid/jdbc/driver/ cubrid/jdbc/jci/ cubrid/sql/ cubrid/jdbc/driver/CUBRIDBlob.class ... CUBRID-JDBC-8.3.1.1032 **Registering CUBRID JDBC Driver** Use the **Class.forName** (*driver-class-name*) command to register CUBRID JDBC driver. The following example shows how to load the **cubrid.jdbc.driver.CUBRIDDriver** class to register CUBRID JDBC driver. .. code-block:: java import java.sql.*; import cubrid.jdbc.driver.*; public class LoadDriver { public static void main(String[] Args) { try { Class.forName("cubrid.jdbc.driver.CUBRIDDriver"); } catch (Exception e) { System.err.println("Unable to load driver."); e.printStackTrace(); } ... Installing and Configuring JDBC =============================== **Requirements** * JDK 1.6 or later * CUBRID 2008 R2.0 (8.2.0) or later * CUBRID JDBC driver 2008 R1.0 or later **Installing Java and Configuring Environment** You must already have Java installed and the **JAVA_HOME** environment variable configured in your system. You can download Java from the Developer Resources for Java Technology website ( http://java.sun.com ). For more information, please refer :ref:`jsp-environment-configuration`. **Configuring the environment variables for Windows** After installing Java, right-click [My Computer] and click [System Properties]. In the [Advanced] tab, click [Environment Variables]. The [Environment Variables] dialog will appear. In the [System Variables], click [New]. Enter **JAVA_HOME** and Java installation path such as C:\Program Files\Java\jdk1.6.0_13 and then click [OK]. .. image:: /images/image51.png Of system variables, select Path and then click [Edit]. Add **%JAVA_HOME%\\bin** in the [Variable value] and then click [OK]. .. image:: /images/image52.png You can also configure **JAVA_HOME** and **PATH** values in the shell instead of using the way described above. :: set JAVA_HOME= C:\Program Files\Java\jdk1.6.0_13 set PATH=%PATH%;%JAVA_HOME%\bin **Configuring the environment variables for Linux** Specify the directory path where Java is installed (example: /usr/java/jdk1.6.0_13) as a **JAVA_HOME** environment variable and add **$JAVA_HOME/bin** to the **PATH** environment variable. :: export JAVA_HOME=/usr/java/jdk1.6.0_16 #bash export PATH=$JAVA_HOME/bin:$PATH #bash setenv JAVA_HOME /usr/java/jdk1.6.0_16 #csh set path = ($JAVA_HOME/bin $path) #csh **Configuring JDBC Driver** To use JDBC, you should specify the path where the CUBRID JDBC driver is located in the **CLASSPATH** environment variable. The CUBRID JDBC driver (**cubrid_jdbc.jar**) is located in the jdbc directory under the directory of CUBRID installation. .. image:: /images/image53.png **Configuring the CLASSPATH environment variable for Windows** :: set CLASSPATH=C:\CUBRID\jdbc\cubrid_jdbc.jar:. **Configuring the CLASSPATH environment variable for Linux** :: export CLASSPATH=$HOME/CUBRID/jdbc/cubrid_jdbc.jar:. .. warning:: If a general CUBRID JDBC driver has been installed in the same library directory (**$JAVA_HOME/jre/lib/ext**) where the JRE is installed, it may be loaded ahead of the server-side JDBC driver used by the Java stored procedure, which causing it to malfunction. In a Java stored procedure environment, make sure not to install a general CUBRID JDBC driver in the directory where the JRE is installed (**$JAVA_HOME/jre/lib/ext**). JDBC Programming ================ .. _jdbc-connection-conf: Configuration Connection ------------------------ The **DriverManager** is an interface for managing the JDBC driver. It is used to select a driver and create new database connection. If CUBRID JDBC driver is registered, you can connect a database by calling the **DriverManager.getConnection** (*db-url*, *user-id*, *password*) method. The **getConnection** method returns the **Connection** object and it is used to execute queries and commands, and commit and roll back transactions. The syntax below shows the *db-url* argument for configuring connection. :: jdbc:cubrid::::[user-id]:[password]:[? [& ]] ::= hostname | ip_address ::= altHosts= | rcTime= | loadBalance= | connectTimeout= | queryTimeout= | charSet= | zeroDateTimeBehavior= | logFile= | logOnException= | logSlowQueries=&slowQueryThresholdMillis= | useLazyConnection= ::= : [,:] ::= exception | round | convertToNull ::= true | false * *host*: IP address or host name where the CUBRID broker is running * *port*: The CUBRID broker port number (default value: 33,000) * *db-name*: The name of the database to connect * *user-id*: The user ID which is connected to a database. There are two types of users in a database by default: **DBA** and **PUBLIC**. If an empty string ("") is entered, a database is connected by the **PUBLIC** user. * *password*: The password of a user who is to be connected to a database. If no password is set, enter an empty string (""). * **altHosts**: The host IP addresses and connection ports of one or more stand by brokers which will perform failover in the HA environment. .. note:: Even if there are **RW** and **RO** together in *ACCESS_MODE** setting of brokers of main host and **altHosts**, application decides the target host to access without the relation for the setting of **ACCESS_MODE**. Therefore, you should define the main host and **altHosts** as considering **ACCESS_MODE** of target brokers. * **rcTime**: Interval time (in seconds) to try to connect active brokers during failover in the HA environment. See the below URL example. * **loadBalance** : If this value is true, the application tries to connect with main host and altHosts in random order(default value: false). .. note:: Even if there are **RW** and **RO** together in *ACCESS_MODE** setting of brokers of main host and **altHosts**, application decides the target host to access without the relation for the setting of **ACCESS_MODE**. Therefore, you should define the main host and **altHosts** as considering **ACCESS_MODE** of target brokers. * **connectTimeout**: Timeout value (in seconds) for database connection. The default value is 30 seconds. If this value is 0, it means infinite waiting. This value is also applied when internal reconnection occurs after the initial connection. The **DriverManger.setLoginTimeout** () method can be used to configure it; however, the value configured in this method will be ignored if a value is configured in the connection URL. * **queryTimeout** : Timeout value (in seconds) for query execution (default value: 0, infinite). The maximum value is 2,000,000. This value can be changed by the **DriverManger.setQueryTimeout** () method. .. note:: When you run executeBatch() method, the query timeout is applied in one method call, not in one query. * **charSet** : The character set of a database to be connected * **zeroDateTimeBehavior** : The property used to determine the way to handle an output value; because JDBC does not allow a value having zero for both date and time regardless of date and time in the object with the **java.sql.Date** type. For information about the value having zero for both date and date, see :ref:`date-time-type`. The default operation is **exception**. The operation for each configuration is as follows: * **exception** : Default operation. It is handled as an SQLException exception. * **round** : Converts to the minimum value allowed for a type to be returned. Exceptionally, when the value's type is TIMESTAMP, this value is rounded as '1970-01-01 00:00:00'(GST). (yyyy-mm-dd hh24:mi:ss) * **convertToNull** : Converts to **NULL**. * **logFile** : The name of a log file for debugging (default value: cubrid_jdbc.log). If a path is not configured, it is stored the location where applications are running. * **logOnException** : Whether to log exception handling for debugging (default value: false) * **logSlowQueries** : Whether to log slow queries for debugging (default value: false) * **slowQueryThresholdMillis**: Timeout value (in milliseconds) of slow queries (default value: 60,000). * **useLazyConnection**: If this is true, it returns success without connecting to the broker when user requests the connection, and it connects to the broker after calling prepare or execute function(default: false). If this value is true, it can prevent from access delay or failure as many application clients restart simultaniously and create connection pools. **Example 1** :: --connection URL string when user name and password omitted URL=jdbc:CUBRID:192.168.0.1:33000:demodb:public:: --connection URL string when zeroDateTimeBehavior property specified URL=jdbc:CUBRID:127.0.0.1:33000:demodb:public::?zeroDateTimeBehavior=convertToNull --connection URL string when charSet property specified URL=jdbc:CUBRID:192.168.0.1:33000:demodb:public::?charSet=utf-8 --connection URL string when queryTimeout and charSet property specified URL=jdbc:CUBRID:127.0.0.1:33000:demodb:public::?queryTimeout=1&charSet=utf-8 --connection URL string when a property(altHosts) specified for HA URL=jdbc:CUBRID:192.168.0.1:33000:demodb:public::?altHosts=192.168.0.2:33000,192.168.0.3:33000 --connection URL string when properties(altHosts,rcTime, connectTimeout) specified for HA URL=jdbc:CUBRID:192.168.0.1:33000:demodb:public::?altHosts=192.168.0.2:33000,192.168.0.3:33000&rcTime=600&connectTimeout=5 --connection URL string when properties(altHosts,rcTime, charSet) specified for HA URL=jdbc:CUBRID:192.168.0.1:33000:demodb:public::?altHosts=192.168.0.2:33000,192.168.0.3:33000&rcTime=600&charSet=utf-8 **Example 2** .. code-block:: java String url = "jdbc:cubrid:192.168.0.1:33000:demodb:public::"; String userid = ""; String password = ""; try { Connection conn = DriverManager.getConnection(url,userid,password); // Do something with the Connection ... } catch (SQLException e) { System.out.println("SQLException:" + e.getMessage()); System.out.println("SQLState: " + e.getSQLState()); } ... .. note:: * Because a colon (:) and a question mark are used as a separator in the URL string, it is not allowed to use them as parts of a password. To use them in a password, you must specify a user name (*user-id*) and a password (*password*) as a separate argument in the **getConnection** method. * The database connection in thread-based programming must be used independently each other. * The rollback method requesting transaction rollback will be ended after a server completes the rollback job. * In autocommit mode, the transaction is not committed if all results are not fetched after running the SELECT statement. Therefore, although in autocommit mode, you should end the transaction by executing COMMIT or ROLLBACK if some error occurs during fetching for the resultset. .. _jdbc-con-tostring: Checking SQL LOG ---------------- The connection URL information can be printed out by calling cubrid.jdbc.driver.CUBRIDConnection.toString() method. :: e.g.) cubrid.jdbc.driver.CUBRIDConnection(CAS ID : 1, PROCESS ID : 22922) You can find SQL log of that CAS easily by CAS ID which is printed out. For more details, see :ref:`sql-log-check`. Checking Foreign Key Information -------------------------------- You can check foreign key information by using **getImportedKeys**, **getExportedKeys**, and **getCrossReference** methods of the **DatabaseMetaData** interface. The usage and example of each method are as follows: .. code-block:: java getImportedKeys(String catalog, String schema, String table) getExportedKeys(String catalog, String schema, String table) getCrossReference(String parentCatalog, String parentSchema, String parentTable, String foreignCatalog, String foreignSchema, String foreignTable) * **getImportedKeys** method: Retrieves information of primary key columns which are referred by foreign key columns in a given table. The results are sorted by **PKTABLE_NAME** and **KEY_SEQ**. * **getExportedKeys** method: Retrieves information of all foreign key columns which refer to primary key columns in a given table. The results are sorted by **FKTABLE_NAME** and **KEY_SEQ**. * **getCrossReference** method: Retrieves information of primary key columns which are referred by foreign key columns in a given table. The results are sorted by **PKTABLE_NAME** and **KEY_SEQ**. **Return Value** When the methods above are called, the ResultSet consisting of 14 columns listed in the table below is returned. +---------------+----------+---------------------------------------------------------------------------------------------------------+ | Name | Type | Note | +===============+==========+=========================================================================================================+ | PKTABLE_CAT | String | null without exception | +---------------+----------+---------------------------------------------------------------------------------------------------------+ | PKTABLE_SCHEM | String | null without exception | +---------------+----------+---------------------------------------------------------------------------------------------------------+ | PKTABLE_NAME | String | The name of a primary key table | +---------------+----------+---------------------------------------------------------------------------------------------------------+ | PKCOLUMN_NAME | String | The name of a primary key column | +---------------+----------+---------------------------------------------------------------------------------------------------------+ | FKTABLE_CAT | String | null without exception | +---------------+----------+---------------------------------------------------------------------------------------------------------+ | FKTABLE_SCHEM | String | null without exception | +---------------+----------+---------------------------------------------------------------------------------------------------------+ | FKTABLE_NAME | String | The name of a foreign key table | +---------------+----------+---------------------------------------------------------------------------------------------------------+ | FKCOLUMN_NAME | String | The name of a foreign key column | +---------------+----------+---------------------------------------------------------------------------------------------------------+ | KEY_SEQ | short | Sequence of columns of foreign keys or primary keys (starting from 1) | +---------------+----------+---------------------------------------------------------------------------------------------------------+ | UPDATE_RULE | short | The corresponding values to referring actions defined as to foreign keys when primary keys are updated. | | | | Cascade=0, Restrict=2, No action=3, Set null=4 | +---------------+----------+---------------------------------------------------------------------------------------------------------+ | DELETE_RULE | short | The corresponding value to referring actions defined as to foreign keys when primary keys are deleted. | | | | Cascade=0, Restrict=2, No action=3, Set null=4 | +---------------+----------+---------------------------------------------------------------------------------------------------------+ | FK_NAME | String | Foreign key name | +---------------+----------+---------------------------------------------------------------------------------------------------------+ | PK_NAME | String | Primary key name | +---------------+----------+---------------------------------------------------------------------------------------------------------+ | DEFERRABILITY | short | 6 without exception (DatabaseMetaData.importedKeyInitiallyImmediate) | +---------------+----------+---------------------------------------------------------------------------------------------------------+ **Example** .. code-block:: java ResultSet rs = null; DatabaseMetaData dbmd = conn.getMetaData(); System.out.println("\n===== Test getImportedKeys"); System.out.println("====="); rs = dbmd.getImportedKeys(null, null, "pk_table"); Test.printFkInfo(rs); rs.close(); System.out.println("\n===== Test getExportedKeys"); System.out.println("====="); rs = dbmd.getExportedKeys(null, null, "fk_table"); Test.printFkInfo(rs); rs.close(); System.out.println("\n===== Test getCrossReference"); System.out.println("====="); rs = dbmd.getCrossReference(null, null, "pk_table", null, null, "fk_table"); Test.printFkInfo(rs); rs.close(); Using Object Identifiers (OIDs) and Collections ----------------------------------------------- In addition to the methods defined in the JDBC specification, CUBRID JDBC driver provides methods that handle OIDs and collections (set, multiset, and sequence). To use these methods, you must import **cubrid.sql.*;** as well as the CUBRID JDBC driver classes which are imported by default. Furthermore, you should convert to not the  **ResultSet** class, which is provided by the standard JDBC API) but the **CUBRIDResultSet** class to get result. .. code-block:: java import cubrid.jdbc.driver.* ; import cubrid.sql.* ; ... CUBRIDResultSet urs = (CUBRIDResultSet) stmt.executeQuery( "SELECT city FROM location"); .. warning:: If extended API is used, transactions won't be automatically committed even though **AUTOCOMMIT** is set to TRUE. Therefore, you must explicitly commit transactions for open connections. The extended API of CUBRID is method that handle OIDs, collections, etc. Using OIDs ^^^^^^^^^^ You must follow the rules below when using OIDs. * To use **CUBRIDOID**, you must **import cubrid.sql.** \* . (a) * You can get OIDs by specifying the class name in the **SELECT** statement. It can also be used together with other properties. (b) * **ResultSet** for queries must be received by **CUBRIDResultSet**. (c) * The method to get OIDs from **CUBRIDResultSet** is **getOID** (). (d) * You can get the value from OIDs by using the **getValues** () method and the result will be **ResultSet**. (e) * You can substitute OID with a value by using the **setValues** () method. (f) * When you use extended API, you must always execute **commit** () for connection. (g) **Example** .. code-block:: java import java.sql.*; import cubrid.sql.*; //a import cubrid.jdbc.driver.*; /* CREATE TABLE oid_test( id INTEGER, name VARCHAR(10), age INTEGER ); INSERT INTO oid_test VALUES(1, 'Laura', 32); INSERT INTO oid_test VALUES(2, 'Daniel', 39); INSERT INTO oid_test VALUES(3, 'Stephen', 38); */ class OID_Sample { public static void main (String args []) { // Making a connection String url= "jdbc:cubrid:localhost:33000:demodb:public::"; String user = "dba"; String passwd = ""; // SQL statement to get OID values String sql = "SELECT oid_test from oid_test"; //b // columns of the table String[] attr = { "id", "name", "age" } ; // Declaring variables for Connection and Statement Connection con = null; Statement stmt = null; CUBRIDResultSet rs = null; ResultSetMetaData rsmd = null; try { Class.forName("cubrid.jdbc.driver.CUBRIDDriver"); } catch (ClassNotFoundException e) { throw new IllegalStateException("Unable to load Cubrid driver", e); } try { con = DriverManager.getConnection(url, user, passwd); stmt = con.createStatement(); rs = (CUBRIDResultSet)stmt.executeQuery(sql); //c rsmd = rs.getMetaData(); // Printing columns int numOfColumn = rsmd.getColumnCount(); for (int i = 1; i <= numOfColumn; i++ ) { String ColumnName = rsmd.getColumnName(i); String JdbcType = rsmd.getColumnTypeName(i); System.out.print(ColumnName ); System.out.print("("+ JdbcType + ")"); System.out.print(" | "); } System.out.print("\n"); // Printing rows CUBRIDResultSet rsoid = null; int k = 1; while (rs.next()) { CUBRIDOID oid = rs.getOID(1); //d System.out.print("OID"); System.out.print(" | "); rsoid = (CUBRIDResultSet)oid.getValues(attr); //e while (rsoid.next()) { for( int j=1; j <= attr.length; j++ ) { System.out.print(rsoid.getObject(j)); System.out.print(" | "); } } System.out.print("\n"); // New values of the first row Object[] value = { 4, "Yu-ri", 19 }; if (k == 1) oid.setValues(attr, value); //f k = 0; } con.commit(); //g } catch(CUBRIDException e) { e.printStackTrace(); } catch(SQLException ex) { ex.printStackTrace(); } finally { if(rs != null) try { rs.close(); } catch(SQLException e) {} if(stmt != null) try { stmt.close(); } catch(SQLException e) {} if(con != null) try { con.close(); } catch(SQLException e) {} } } } Using Collections ^^^^^^^^^^^^^^^^^ The line "a" in the example 1 is where data of collection types (**SET**, **MULTISET**, and **LIST**) is fetched from **CUBRIDResultSet**. The results are returned as array format. Note that this can be used only when data types of all elements defined in the collection types are same. **Example 1** .. code-block:: java import java.sql.*; import java.lang.*; import cubrid.sql.*; import cubrid.jdbc.driver.*; // create class collection_test( // settest set(integer), // multisettest multiset(integer), // listtest list(Integer) // ); // // insert into collection_test values({1,2,3},{1,2,3},{1,2,3}); // insert into collection_test values({2,3,4},{2,3,4},{2,3,4}); // insert into collection_test values({3,4,5},{3,4,5},{3,4,5}); class Collection_Sample { public static void main (String args []) { String url= "jdbc:cubrid:127.0.0.1:33000:demodb:public::"; String user = ""; String passwd = ""; String sql = "select settest,multisettest,listtest from collection_test"; try { Class.forName("cubrid.jdbc.driver.CUBRIDDriver"); } catch(Exception e){ e.printStackTrace(); } try { Connection con = DriverManager.getConnection(url,user,passwd); Statement stmt = con.createStatement(); CUBRIDResultSet rs = (CUBRIDResultSet) stmt.executeQuery(sql); CUBRIDResultSetMetaData rsmd = (CUBRIDResultSetMetaData) rs.getMeta Data(); int numbOfColumn = rsmd.getColumnCount(); while (rs.next ()) { for (int j=1; j<=numbOfColumn; j++ ) { Object[] reset = (Object[]) rs.getCollection(j); //a for (int m=0 ; m < reset.length ; m++) System.out.print(reset[m] +","); System.out.print(" | "); } System.out.print("\n"); } rs.close(); stmt.close(); con.close(); } catch(SQLException e) { e.printStackTrace(); } } } **Example 2** .. code-block:: java import java.sql.*; import java.io.*; import java.lang.*; import cubrid.sql.*; import cubrid.jdbc.driver.*; // create class collection_test( // settest set(integer), // multisettest multiset(integer), // listtest list(Integer) // ); // // insert into collection_test values({1,2,3},{1,2,3},{1,2,3}); // insert into collection_test values({2,3,4},{2,3,4},{2,3,4}); // insert into collection_test values({3,4,5},{3,4,5},{3,4,5}); class SetOP_Sample { public static void main (String args []) { String url = "jdbc:cubrid:127.0.0.1:33000:demodb:public::"; String user = ""; String passwd = ""; String sql = "select collection_test from collection_test"; try { Class.forName("cubrid.jdbc.driver.CUBRIDDriver"); } catch(Exception e){ e.printStackTrace(); } try { CUBRIDConnection con =(CUBRIDConnection) DriverManager.getConnection(url,user,passwd); Statement stmt = con.createStatement(); CUBRIDResultSet rs = (CUBRIDResultSet)stmt.executeQuery(sql); while (rs.next ()) { CUBRIDOID oid = rs.getOID(1); oid.addToSet("settest",new Integer(10)); oid.addToSet("multisettest",new Integer(20)); oid.addToSequence("listtest",1,new Integer(30)); oid.addToSequence("listtest",100,new Integer(100)); oid.putIntoSequence("listtest",99,new Integer(99)); oid.removeFromSet("settest",new Integer(1)); oid.removeFromSet("multisettest",new Integer(2)); oid.removeFromSequence("listtest",99); oid.removeFromSequence("listtest",1); } con.commit(); rs.close(); stmt.close(); con.close(); } catch(SQLException e) { e.printStackTrace(); } } } Getting Auto Increment Column Value ----------------------------------- Auto increment (**AUTO_INCREMENT**) is a column-related feature that increments the numeric value of each row. For more information, see :ref:`column-definition`. It can be defined only for numeric domains (**SMALLINT**, **INTEGER**, **DECIMAL** (*p*, 0), and **NUMERIC** (*p*, 0)). Auto increment is recognized as automatically created keys in the JDBC programs. To retrieve the key, you need to specify the time to insert a row from which the automatically created key value is to be retrieved. To perform it, you must set the flag by calling **Connection.prepareStatement** and **Statement.execute** methods. In this case, the command executed should be the **INSERT** statement or **INSERT** within **SELECT** statement. For other commands, the JDBC driver ignores the flag-setting parameter.  **Steps** * Use one of the following to indicate whether or not to return keys created automatically. The following method forms are used for tables of the database server that supports the auto increment columns. Each method form can be applied only to a single-row **INSERT** statement. * Write the **PreparedStatement** object as shown below. .. code-block:: java Connection.prepareStatement(sql statement, Statement.RETURN_GENERATED_KEYS); * To insert a row by using the **Statement.execute** method, use the **Statement.execute** method as shown below. .. code-block:: java Statement.execute(sql statement, Statement.RETURN_GENERATED_KEYS); * Get the **ResultSet** object containing automatically created key values by calling the **PreparedStatement.getGeneratedKeys** or **Statement.getGeneratedKeys** method. Note that the data type of the automatically created keys in **ResultSet** is **DECIMAL** regardless of the data type of the given domain. **Example** The following example shows how to create a table with auto increment, enter data into the table so that automatically created key values are entered into auto increment columns, and check whether the key values are successfully retrieved by using the **Statement.getGeneratedKeys** () method. Each step is explained in the comments for commands that correspond to the steps above. .. code-block:: java import java.sql.*; import java.math.*; import cubrid.jdbc.driver.*; Connection con; Statement stmt; ResultSet rs; java.math.BigDecimal iDColVar; ... stmt = con.createStatement(); // Create a Statement object // Create table with identity column stmt.executeUpdate( "CREATE TABLE EMP_PHONE (EMPNO CHAR(6), PHONENO CHAR(4), " + "IDENTCOL INTEGER AUTO_INCREMENT)"); stmt.execute( "INSERT INTO EMP_PHONE (EMPNO, PHONENO) " + "VALUES ('000010', '5555')", // Insert a row Statement.RETURN_GENERATED_KEYS); // Indicate you want automatically rs = stmt.getGeneratedKeys(); // generated keys // Retrieve the automatically // generated key value in a ResultSet. // Only one row is returned. // Create ResultSet for query while (rs.next()) { java.math.BigDecimal idColVar = rs.getBigDecimal(1); // Get automatically generated key value System.out.println("automatically generated key value = " + idColVar); } rs.close(); // Close ResultSet stmt.close(); // Close Statement Using BLOB/CLOB --------------- The interface that handles **LOB** data in JDBC is implemented based on JDBC 4.0 specification. The constraints of the interface are as follows: * Only sequential write is supported when creating **BLOB** or **CLOB** object. Writing to arbitrary locations is not supported. * You cannot change **BLOB** or **CLOB** data by calling methods of **BLOB** or **CLOB** object fetched from **ResultSet**.  * **Blob.truncate**, **Clob.truncate**, **Blob.position**, and **Clob.position** methods are supported. * You cannot bind the LOB data by calling **PreparedStatement.setAsciiStream**, **PreparedStatement.setBinaryStream**, and **PreparedStatement.setCharacterStream** methods for **BLOB/CLOB** type columns. * To use **BLOB** / **CLOB** type in the environment where JDBC 4.0 is not supported such as JDK versions 1.5 or earlier, you must do explicit type conversion for the conn object to **CUBRIDConnection**. See example below. .. code-block:: java //JDK 1.6 or higher import java.sql.*; Connection conn = DriverManager.getConnection(url, id, passwd); Blob blob = conn.createBlob(); //JDK 1.5 or lower import java.sql.*; import cubrid.jdbc.driver.*; Connection conn = DriverManager.getConnection(url, id, passwd); Blob blob = ((CUBRIDConnection)conn).createBlob(); **Storing LOB Data** You can bind the **LOB** type data in the following ways. * Create **java.sql.Blob** or **java.sql.Clob** object, store file content in the object, use **setBlob** () or **setClob** () of **PreparedStatement** (example 1). * Execute a query, get **java.sql.Blob** or **java.sql.Clob** object from the **ResultSet** object, and bind the object in **PreparedStatement** (example 2). **Example 1** .. code-block:: java Class.forName("cubrid.jdbc.driver.CUBRIDDriver"); Connection conn = DriverManager.getConnection ("jdbc:cubrid:localhost:33000:image_db:user1:password1:", "", ""); PreparedStatement pstmt1 = conn.prepareStatement("INSERT INTO doc(image_id, doc_id, image) VALUES (?,?,?)"); pstmt1.setString(1, "image-21"); pstmt1.setString(2, "doc-21"); //Creating an empty file in the file system Blob bImage = conn.createBlob(); byte[] bArray = new byte[256]; ... //Inserting data into the external file. Position is start with 1. bImage.setBytes(1, bArray); //Appending data into the external file bImage.setBytes(257, bArray); ... pstmt1.setBlob(3, bImage); pstmt1.executeUpdate(); ... **Example 2** .. code-block:: java Class.forName("cubrid.jdbc.driver.CUBRIDDriver"); Connection conn = DriverManager.getConnection ("jdbc:cubrid:localhost:33000:image_db:user1:password1:", "", ""); conn.setAutoCommit(false); PreparedStatement pstmt1 = conn.prepareStatement("SELECT image FROM doc WHERE image_id = ? "); pstmt1.setString(1, "image-21"); ResultSet rs = pstmt1.executeQuery(); while (rs.next()) { Blob bImage = rs.getBlob(1); PreparedStatement pstmt2 = conn.prepareStatement("INSERT INTO doc(image_id, doc_id, image) VALUES (?,?,?)"); pstmt2.setString(1, "image-22") pstmt2.setString(2, "doc-22") pstmt2.setBlob(3, bImage); pstmt2.executeUpdate(); pstmt2.close(); } pstmt1.close(); conn.commit(); conn.setAutoCommit(true); conn.close(); ... **Getting LOB Data** You can get the **LOB** type data in the following ways. * Get data directly from **ResultSet** by using **getBytes** () or **getString** () method (example 1). * Get the java.sql.Blob or java.sql.Clob object from **ResultSet** by calling **getBlob** () or **getClob** () method and get data for this object by using the **getBytes** () or **getSubString** () method (example 2). **Example 1** .. code-block:: java Connection conn = DriverManager.getConnection ("jdbc:cubrid:localhost:33000:image_db:user1:password1:", "", ""); // Getting data directly from ResetSet PrepareStatement pstmt1 = conn.prepareStatement("SELECT content FROM doc_t WHERE doc_id = ? "); pstmt2.setString(1, "doc-10"); ResultSet rs = pstmt1.executeQuery(); while (rs.next()) { String sContent = rs.getString(1); System.out.println("doc.content= "+sContent.); } **Example 2** .. code-block:: java Connection conn = DriverManager.getConnection ("jdbc:cubrid:localhost:33000:image_db:user1:password1:", "", ""); // Getting BLOB data from ResultSet and getting data from the BLOB object PrepareStatement pstmt2 = conn.prepareStatement("SELECT image FROM image_t WHERE image_id = ?"); pstmt2.setString(1,"image-20"); ResultSet rs = pstmt2.executeQuery(); while (rs.next()) { Blob bImage = rs.getBlob(1); Bytes[] bArray = bImange.getBytes(1, (int)bImage.length()); } .. note:: If a string longer than defined max length is inserted (**INSERT**) or updated (**UPDATE**), the string will be truncated. .. _jdbc-error-codes: JDBC Error Codes and Error Messages ----------------------------------- JDBC error codes which occur in SQLException are as follows. * All error codes are negative. * After SQLException, error number can be shown by SQLException.getErrorCode() and error message can be shown by SQLException.getMessage(). * If the value of error code is between -2001 and -2999, it is caused by CUBRID JDBC methods. * If the value of error code is between -1000 and -1999, it is caused by CAS and transferred by JDBC methods. For CAS errors, see :ref:`cas-error`. * If the value of error code is between 0 and -999, it is caused by database server. For database server errors, see :ref:`database-server-error`. +--------------+--------------------------------------------------------------------------------------+ | Error Number | Error Message | +==============+======================================================================================+ | -2001 | Index's Column is Not Object | +--------------+--------------------------------------------------------------------------------------+ | -2002 | Server error | +--------------+--------------------------------------------------------------------------------------+ | -2003 | Cannot communicate with the broker | +--------------+--------------------------------------------------------------------------------------+ | -2004 | Invalid cursor position | +--------------+--------------------------------------------------------------------------------------+ | -2005 | Type conversion error | +--------------+--------------------------------------------------------------------------------------+ | -2006 | Missing or invalid position of the bind variable provided | +--------------+--------------------------------------------------------------------------------------+ | -2007 | Attempt to execute the query when not all the parameters are binded | +--------------+--------------------------------------------------------------------------------------+ | -2008 | Internal Error: NULL value | +--------------+--------------------------------------------------------------------------------------+ | -2009 | Column index is out of range | +--------------+--------------------------------------------------------------------------------------+ | -2010 | Data is truncated because receive buffer is too small | +--------------+--------------------------------------------------------------------------------------+ | -2011 | Internal error: Illegal schema type | +--------------+--------------------------------------------------------------------------------------+ | -2012 | File access failed | +--------------+--------------------------------------------------------------------------------------+ | -2013 | Cannot connect to a broker | +--------------+--------------------------------------------------------------------------------------+ | -2014 | Unknown transaction isolation level | +--------------+--------------------------------------------------------------------------------------+ | -2015 | Internal error: The requested information is not available | +--------------+--------------------------------------------------------------------------------------+ | -2016 | The argument is invalid | +--------------+--------------------------------------------------------------------------------------+ | -2017 | Connection or Statement might be closed | +--------------+--------------------------------------------------------------------------------------+ | -2018 | Internal error: Invalid argument | +--------------+--------------------------------------------------------------------------------------+ | -2019 | Cannot communicate with the broker or received invalid packet | +--------------+--------------------------------------------------------------------------------------+ | -2020 | No More Result | +--------------+--------------------------------------------------------------------------------------+ | -2021 | This ResultSet do not include the OID | +--------------+--------------------------------------------------------------------------------------+ | -2022 | Command is not insert | +--------------+--------------------------------------------------------------------------------------+ | -2023 | Error | +--------------+--------------------------------------------------------------------------------------+ | -2024 | Request timed out | +--------------+--------------------------------------------------------------------------------------+ | -2101 | Attempt to operate on a closed Connection. | +--------------+--------------------------------------------------------------------------------------+ | -2102 | Attempt to access a closed Statement. | +--------------+--------------------------------------------------------------------------------------+ | -2103 | Attempt to access a closed PreparedStatement. | +--------------+--------------------------------------------------------------------------------------+ | -2104 | Attempt to access a closed ResultSet. | +--------------+--------------------------------------------------------------------------------------+ | -2105 | Not supported method | +--------------+--------------------------------------------------------------------------------------+ | -2106 | Unknown transaction isolation level. | +--------------+--------------------------------------------------------------------------------------+ | -2107 | invalid URL - | +--------------+--------------------------------------------------------------------------------------+ | -2108 | The database name should be given. | +--------------+--------------------------------------------------------------------------------------+ | -2109 | The query is not applicable to the executeQuery(). Use the executeUpdate() instead. | +--------------+--------------------------------------------------------------------------------------+ | -2110 | The query is not applicable to the executeUpdate(). Use the executeQuery() instead. | +--------------+--------------------------------------------------------------------------------------+ | -2111 | The length of the stream cannot be negative. | +--------------+--------------------------------------------------------------------------------------+ | -2112 | An IOException was caught during reading the inputstream. | +--------------+--------------------------------------------------------------------------------------+ | -2113 | Not supported method, because it is deprecated. | +--------------+--------------------------------------------------------------------------------------+ | -2114 | The object does not seem to be a number. | +--------------+--------------------------------------------------------------------------------------+ | -2115 | Missing or invalid position of the bind variable provided. | +--------------+--------------------------------------------------------------------------------------+ | -2116 | The column name is invalid. | +--------------+--------------------------------------------------------------------------------------+ | -2117 | Invalid cursor position. | +--------------+--------------------------------------------------------------------------------------+ | -2118 | Type conversion error. | +--------------+--------------------------------------------------------------------------------------+ | -2119 | Internal error: The number of attributes is different from the expected. | +--------------+--------------------------------------------------------------------------------------+ | -2120 | The argument is invalid. | +--------------+--------------------------------------------------------------------------------------+ | -2121 | The type of the column should be a collection type. | +--------------+--------------------------------------------------------------------------------------+ | -2122 | Attempt to operate on a closed DatabaseMetaData. | +--------------+--------------------------------------------------------------------------------------+ | -2123 | Attempt to call a method related to scrollability of non-scrollable ResultSet. | +--------------+--------------------------------------------------------------------------------------+ | -2124 | Attempt to call a method related to sensitivity of non-sensitive ResultSet. | +--------------+--------------------------------------------------------------------------------------+ | -2125 | Attempt to call a method related to updatability of non-updatable ResultSet. | +--------------+--------------------------------------------------------------------------------------+ | -2126 | Attempt to update a column which cannot be updated. | +--------------+--------------------------------------------------------------------------------------+ | -2127 | The query is not applicable to the executeInsert(). | +--------------+--------------------------------------------------------------------------------------+ | -2128 | The argument row can not be zero. | +--------------+--------------------------------------------------------------------------------------+ | -2129 | Given InputStream object has no data. | +--------------+--------------------------------------------------------------------------------------+ | -2130 | Given Reader object has no data. | +--------------+--------------------------------------------------------------------------------------+ | -2131 | Insertion query failed. | +--------------+--------------------------------------------------------------------------------------+ | -2132 | Attempt to call a method related to scrollability of TYPE_FORWARD_ONLY Statement. | +--------------+--------------------------------------------------------------------------------------+ | -2133 | Authentication failure | +--------------+--------------------------------------------------------------------------------------+ | -2134 | Attempt to operate on a closed PooledConnection. | +--------------+--------------------------------------------------------------------------------------+ | -2135 | Attempt to operate on a closed XAConnection. | +--------------+--------------------------------------------------------------------------------------+ | -2136 | Illegal operation in a distributed transaction | +--------------+--------------------------------------------------------------------------------------+ | -2137 | Attempt to access a CUBRIDOID associated with a Connection which has been closed. | +--------------+--------------------------------------------------------------------------------------+ | -2138 | The table name is invalid. | +--------------+--------------------------------------------------------------------------------------+ | -2139 | Lob position to write is invalid. | +--------------+--------------------------------------------------------------------------------------+ | -2140 | Lob is not writable. | +--------------+--------------------------------------------------------------------------------------+ | -2141 | Request timed out. | +--------------+--------------------------------------------------------------------------------------+ JDBC Sample Program =================== The following sample shows how to connect to CUBRID by using the JDBC driver, and retrieve and insert data. To run the sample program, make sure that the database you are trying to connect to and the CUBRID broker are running. In the sample, you will use the *demodb* database that is automatically created during the installation. **Loading JDBC Driver** To connect to CUBRID, load the JDBC driver by using the **forName** () method of the **Class**. For more information, see :ref:`jdbc-overview` of the JDBC driver. .. code-block:: java Class.forName("cubrid.jdbc.driver.CUBRIDDriver"); **Connecting to Database** After loading the JDBC driver, use the **getConnection** () method of the **DriverManager** to connect to the database. To create a **Connection** object, you must specify information such as the URL which indicates the location of a database, user name, password, etc. For more information, see :ref:`jdbc-connection-conf`. .. code-block:: java String url = "jdbc:cubrid:localhost:33000:demodb:::"; String userid = "dba"; String password = ""; Connection conn = DriverManager.getConnection(url,userid,password); **Manipulating Database (Executing Queries and Processing ResultSet)** To send a query statement to the connected database and execute it, create **Statement**, **PrepardStatement**, and **CallableStatemen** objects. After the **Statement** object is created, execute the query statement by using **executeQuery** () or **executeUpdate** () method of the **Statement** object. You can use the **next** () method to process the next row from the **ResultSet** that has been returned as a result of executing the **executeQuery** () method. .. warning:: If you execute commit after query execution, **ResultSet** will be automatically closed. Therefore, you must not use **ResultSet** after commit. Generally CUBRID is executed in auto-commit mode; if you do not want for CUBRID being executed in auto-commit mode, you should specify **conn.setAutocommit(false);** in the code. **Disconnecting from Database** You can disconnect from a database by executing the **close** () method for each object. The following example shows how to connect to the *demodb* database, create a table, execute a query statement with the prepared statement, and roll back the query statement. You can also practice it yourself by appropriately modifying argument values of the **getConnection** () method. .. code-block:: java import java.util.*; import java.sql.*; public class Basic { public static Connection connect() { Connection conn = null; try { Class.forName("cubrid.jdbc.driver.CUBRIDDriver"); conn = DriverManager.getConnection("jdbc:cubrid:localhost:33000:demodb:::","dba",""); conn.setAutoCommit (false) ; } catch ( Exception e ) { System.err.println("SQLException : " + e.getMessage()); } return conn; } public static void printdata(ResultSet rs) { try { ResultSetMetaData rsmd = null; rsmd = rs.getMetaData(); int numberofColumn = rsmd.getColumnCount(); while (rs.next ()) { for(int j=1; j<=numberofColumn; j++ ) System.out.print(rs.getString(j) + " " ); System.out.println(""); } } catch ( Exception e ) { System.err.println("SQLException : " + e.getMessage()); } } public static void main(String[] args) throws Exception { Connection conn = null; Statement stmt = null; ResultSet rs = null; PreparedStatement preStmt = null; try { conn = connect(); stmt = conn.createStatement(); stmt.executeUpdate("CREATE TABLE xoo ( a INT, b INT, c CHAR(10))"); preStmt = conn.prepareStatement("INSERT INTO xoo VALUES(?,?,''''100'''')"); preStmt.setInt (1, 1) ; preStmt.setInt (2, 1*10) ; int rst = preStmt.executeUpdate () ; rs = stmt.executeQuery("select a,b,c from xoo" ); printdata(rs); conn.rollback(); stmt.close(); conn.close(); } catch ( Exception e ) { conn.rollback(); System.err.println("SQLException : " + e.getMessage()); } finally { if ( conn != null ) conn.close(); } } } The following example shows how to execute the **SELECT** statement by connecting to *demodb* which is automatically created when installing CUBRID. .. code-block:: java import java.sql.*; public class SelectData { public static void main(String[] args) throws Exception { Connection conn = null; Statement stmt = null; ResultSet rs = null; try { // CUBRID에 Connect Class.forName("cubrid.jdbc.driver.CUBRIDDriver"); conn = DriverManager.getConnection("jdbc:cubrid:localhost:33000:demodb:::","dba",""); String sql = "SELECT name, players FROM event"; stmt = conn.createStatement(); rs = stmt.executeQuery(sql); while(rs.next()) { String name = rs.getString("name"); String players = rs.getString("players"); System.out.println("name ==> " + name); System.out.println("Number of players==> " + players); System.out.println("\n=========================================\n"); } rs.close(); stmt.close(); conn.close(); } catch ( SQLException e ) { System.err.println(e.getMessage()); } catch ( Exception e ) { System.err.println(e.getMessage()); } finally { if ( conn != null ) conn.close(); } } } The following example shows how to execute the **INSERT** statement by connecting to *demodb* which is automatically created when installing CUBRID. You can delete or update data the same way as you insert data so you can reuse the code below by simply modifying the query statement in the code. .. code-block:: java import java.sql.*; public class insertData { public static void main(String[] args) throws Exception { Connection conn = null; Statement stmt = null; try { // CUBRID에 Connect Class.forName("cubrid.jdbc.driver.CUBRIDDriver"); conn = DriverManager.getConnection("jdbc:cubrid:localhost:33000:demodb:::","dba",""); String sql = "insert into olympic(host_year, host_nation, host_city, opening_date, closing_date) values (2008, 'China', 'Beijing', to_date('08-08-2008','mm-dd-yyyy'), to_date('08-24-2008','mm-dd-yyyy'))"; stmt = conn.createStatement(); stmt.executeUpdate(sql); System.out.println("데이터가 입력되었습니다."); stmt.close(); } catch ( SQLException e ) { System.err.println(e.getMessage()); } catch ( Exception e ) { System.err.println(e.getMessage()); } finally { if ( conn != null ) conn.close(); } } } JDBC API ======== For details about JDBC API, see Java API Specification (http://docs.oracle.com/javase/7/docs/api) and for details about Java, see Java SE Documentation (http://www.oracle.com/technetwork/java/javase/documentation/index.htm). The following table shows the JDBC standard and extended interface supported by CUBRID. Note that some methods are not supported even though they are included in the JDBC 2.0 specification. **Supported JDBC Interface by CUBRID** +-----------------------------------------------+----------------------------------+---------------------------------------------------------+ | JDBC Standard Interface | JDBC Extended Interface | Supported | +===============================================+==================================+=========================================================+ | java.sql.Blob | java.sql.CUBRIDPreparedStatement | Supported | | java.sql.CallableStatement | java.sql.CUBRIDResultSet | | | java.sql.Clob | java.sql.CUBRIDResultSetMetaData | | | java.sql.Connection | CUBRIDOID | | | java.sql.DatabaseMetaData | | | | java.sql.Driver | | | | java.sql.PreparedStatement | | | | java.sql.ResultSet java.sql.ResultSetMetaData | | | +-----------------------------------------------+----------------------------------+---------------------------------------------------------+ | java.sql.Statement | java.sql.CUBRIDStatement | The getGeneratedKeys() method of JDBC 3.0 is supported. | +-----------------------------------------------+----------------------------------+---------------------------------------------------------+ | java.sql.DriverManager |   | Supported | +-----------------------------------------------+----------------------------------+---------------------------------------------------------+ | Java.sql.SQLException | Java.sql.CUBRIDException | Supported | +-----------------------------------------------+----------------------------------+---------------------------------------------------------+ | java.sql.Array |   | Not Supported | | java.sql.ParameterMetaData | | | | java.sql.Ref | | | | java.sql.Savepoint | | | | java.sql.SQLData | | | | java.sql.SQLInput | | | | java.sql.Struct | | | +-----------------------------------------------+----------------------------------+---------------------------------------------------------+ .. note:: * From CUBRID 2008 R4.3 version, the behavior of batching the queries on the autocommit mode was changed. The methods that batch the queries are PreparedStatement.executeBatch and Statement.executeBatch. Until 2008 R4.1 version, these methods had committed the transaction after executing all queries on the array. From 2008 R4.3, they commit each query on the array. * In autocommit mode off, if the general error occurs during executing one of the queries in the array on the method which does a batch processing of the queries, the query with an error is ignored and the next query is executed continuously. But if the deadlock occurs, the error occurs as rolling back the transaction.